Skip to content

docs(toast): updated toast docs for accessibility#5441

Merged
nikkimk merged 7 commits intomainfrom
nikkimk/toast-docs
May 6, 2025
Merged

docs(toast): updated toast docs for accessibility#5441
nikkimk merged 7 commits intomainfrom
nikkimk/toast-docs

Conversation

@nikkimk
Copy link
Contributor

@nikkimk nikkimk commented May 6, 2025 •
edited by caseyisonit
Loading

Description

Documentation should provide more information and examples that demonstrate how to use the components accessibly.

Motivation and context

Improving the accessibility documentation of the toast component.

Related issue(s)

  • SWC-834

Screenshots (if appropriate)

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes. (N/A this is a docs PR)
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features (N/A this is a docs PR)
  • Automated tests cover all use cases and follow best practices for writing (N/A this is a docs PR)
  • Validated on all supported browsers
  • All VRTs are approved before author can update Golden Hash

Manual review test cases

Review toast docs

  • Do the docs examples give enough context to test for accessibility?
  • Do the docs examples and text provide information on how to use the component accessibly?
  • If the component is to be used in the context of another component, do the examples include how that component is used accessibly in that context?
  • Are the docs headings logical and consistent across these components? You can use the WAVE browser extension's Structure tab to review heading structure.

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

@changeset-bot
Copy link

changeset-bot bot commented May 6, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 32d466d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2025

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@nikkimk nikkimk changed the title Nikkimk/toast docs docs(toast): updated toast docs for accessibility May 6, 2025
@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2025

Tachometer results

Currently, no packages are changed by this PR...

@nikkimk nikkimk marked this pull request as ready for review May 6, 2025 17:56
@nikkimk nikkimk requested a review from a team as a code owner May 6, 2025 17:56
cdransf
cdransf approved these changes May 6, 2025
View reviewed changes
Copy link
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨

@caseyisonit caseyisonit added Status:Ready for review PR ready for review or re-review. Component:Toast labels May 6, 2025
caseyisonit
caseyisonit reviewed May 6, 2025
View reviewed changes
packages/toast/README.md
<sp-toast open timeout="6000">
This message will disappear after 6 seconds.
</sp-toast>
```
Copy link
Contributor

@caseyisonit caseyisonit May 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: would be nice to have a reset button to see this in action, by the time I got to this section it had already timed out and just looked empty

caseyisonit
caseyisonit approved these changes May 6, 2025
View reviewed changes
Copy link
Contributor

@caseyisonit caseyisonit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:chef-kiss:

@nikkimk nikkimk enabled auto-merge (squash) May 6, 2025 22:45
@nikkimk nikkimk merged commit ba4e9bd into main May 6, 2025
23 of 24 checks passed
@nikkimk nikkimk deleted the nikkimk/toast-docs branch May 6, 2025 22:48
castastrophe pushed a commit that referenced this pull request May 9, 2025
@nikkimk @caseyisonit @castastrophe
docs(toast): updated toast docs for accessibility (#5441)
d3afaca 
* docs(toast): updated toast docs for accessiblity

* docs(toast): updated toast docs for accessiblity

---------

Co-authored-by: Casey Eickhoff <48574582+caseyisonit@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cdransf cdransf cdransf approved these changes

@blunteshwar blunteshwar blunteshwar approved these changes

@caseyisonit caseyisonit caseyisonit approved these changes

Assignees

No one assigned

Labels

Component:Toast Status:Ready for review PR ready for review or re-review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nikkimk @cdransf @blunteshwar @caseyisonit